/*
 * Copyright (c) 2019 GeyserMC. http://geysermc.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @author GeyserMC
 * @link https://github.com/GeyserMC/Geyser
 */

package org.geysermc.api.plugin;

import lombok.Getter;
import lombok.Setter;

/**
 * The class that any main plugin class should extend.
 * The first init point is the constructor, followed by onLoad, and finally onEnable.
 */
public class Plugin {
    protected String name;
    protected String version;

    /**
     * Returns if the plugin is enabled
     *
     * @return if the plugin is enabled
     */
    @Getter
    @Setter
    private boolean enabled = true;

    /**
     * Called when a plugin is enabled
     */
    public void onEnable() {

    }

    /**
     * Called when a plugin is disabled
     */
    public void onDisable() {

    }

    /**
     * Called when a plugin is loaded
     */
    public void onLoad() {

    }

    /**
     * Called when the server is reloaded
     */
    public void onReload() {

    }

    public final String getName() {
        return name;
    }

    @Override
    public final String toString() {
        return getName();
    }
}
